Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: remove an error at the end of the -h "help" flag #1632

Merged
merged 1 commit into from
Jan 18, 2025
Merged

fix: remove an error at the end of the -h "help" flag #1632

merged 1 commit into from
Jan 18, 2025

Conversation

neoandmatrix
Copy link
Contributor

Related issue(s)
Resolves #1625

Description
This PR helps to fix the ERROR message issue in the -h help command flag.

Approach

Upon going through the codebase i first tried to log more of error message and got the following for stack trace of the error message.
15_01_2025_WindowsTerminal_25_54

With referring to above trace and going through the oclif codebase i found that the error being shown here is not an actual error but just used to terminate the help command.
This is that particular code.

Then after carefully going through help command implementation in the oclif codebase and also referring to an already mentioned old issue about this bug and their solution i concluded that this error is safe to ignore as this is expected in the command output and is not critical.

@AayushSaini101 Please review this PR.
Thanks.

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Jan 15, 2025

⚠️ No Changeset found

Latest commit: 937c501

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

github-actions[bot]
github-actions bot reviewed Jan 15, 2025
View reviewed changes
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

@asyncapi-bot
Copy link
Contributor

Hello, @changeset-bot[bot]! 👋🏼

    I'm 🧞🧞🧞 Genie 🧞🧞🧞 from the magic lamp. Looks like somebody needs a hand!

    At the moment the following comments are supported in pull requests:

    - `/please-take-a-look` or `/ptal` - This comment will add a comment to the PR asking for attention from the reviewrs who have not reviewed the PR yet.
    - `/ready-to-merge` or `/rtm` - This comment will trigger automerge of PR in case all required checks are green, approvals in place and do-not-merge label is not added
    - `/do-not-merge` or `/dnm` - This comment will block automerging even if all conditions are met and ready-to-merge label is added
    - `/autoupdate` or `/au` - This comment will add `autoupdate` label to the PR and keeps your PR up-to-date to the target branch's future changes. Unless there is a merge conflict or it is a draft PR. (Currently only works for upstream branches.)
    - `/update` or `/u` - This comment will update the PR with the latest changes from the target branch. Unless there is a merge conflict or it is a draft PR. NOTE: this only updates the PR once, so if you need to update again, you need to call the command again.

@sonarqubecloud SonarQubeCloud
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@AayushSaini101
Copy link
Collaborator

Thank you for the PR : ) @neoandmatrix can you try to verify the changes via running in your local, to verify the changes and running local instructions are given in the contributions guideline of the CLI project

@neoandmatrix
Copy link
Contributor Author

Thank you for the PR : ) @neoandmatrix can you try to verify the changes via running in your local, to verify the changes and running local instructions are given in the contributions guideline of the CLI project

Sure will verify and attach the screenshot of changes.

@neoandmatrix
Copy link
Contributor Author

After doing the mentioned changes in PR and upon running the commands new file -h and start studio -h below are the before and after screenshots

Before changes :-
new file -h

16_01_2025_WindowsTerminal_17_06

start studio -h

16_01_2025_WindowsTerminal_15_53

After changes :-

new file -h

16_01_2025_WindowsTerminal_18_15

start studio -h

16_01_2025_WindowsTerminal_18_39

@AayushSaini101 Please verify.
Thanks.

@AayushSaini101 AayushSaini101 changed the title fix: fix the error at the end of the -h "help" flag fix: Remove the error at the end of the -h "help" flag Jan 16, 2025
@AayushSaini101 AayushSaini101 changed the title fix: Remove the error at the end of the -h "help" flag fix: remove the error at the end of the -h "help" flag Jan 16, 2025
@AayushSaini101 AayushSaini101 changed the title fix: remove the error at the end of the -h "help" flag fix: remove an error at the end of the -h "help" flag Jan 16, 2025
@AayushSaini101
Copy link
Collaborator

/rtm

@asyncapi-bot asyncapi-bot merged commit 5635245 into asyncapi:master Jan 18, 2025
40 of 41 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@github-actions github-actions[bot] github-actions[bot] left review comments

@AayushSaini101 AayushSaini101 AayushSaini101 approved these changes

@Souvikns Souvikns Awaiting requested review from Souvikns Souvikns is a code owner

@Amzani Amzani Awaiting requested review from Amzani Amzani is a code owner

@Shurtu-gal Shurtu-gal Awaiting requested review from Shurtu-gal Shurtu-gal is a code owner

@asyncapi-bot-eve asyncapi-bot-eve Awaiting requested review from asyncapi-bot-eve asyncapi-bot-eve is a code owner

Assignees
No one assigned
Labels
ready-to-merge
Projects
CLI - Kanban
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Help displayed in terminal has always an error at the end
3 participants
@neoandmatrix @asyncapi-bot @AayushSaini101